<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>clGetProgramBuildInfo</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <meta name="keywords" content="&#10;                clGetProgramBuildInfo&#10;            " />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="clGetProgramBuildInfo"></a>
        <h1>
            clGetProgramBuildInfo
        </h1>
        <p>
            Returns build information for each device in the program object.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="scalarDataTypes.html" target="_top">cl_int</a>
 <strong class="fsfunc">clGetProgramBuildInfo</strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="_top">cl_program</a>  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">program</var>, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>cl_device_id  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">device</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_command_queue_properties" target="_top">cl_program_build_info</a>  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_name</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a>  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_value_size</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">void</a>  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a>  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value_size_ret</var><code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="parameters"></a>
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <code class="varname">program</code>
              </span>
            </dt>
            <dd>
              <p> Specifies the program object being queried.</p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">device</code>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the device for which build information is being queried.
                    <code class="varname">device</code> must be a valid device associated with <code class="varname">program</code>.
                </p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">
                        param_name
                </code>
              </span>
            </dt>
            <dd>
              <p>
                        Specifies the information to query. The list of supported <code class="varname">param_name</code> types and the
                        information returned in <code class="varname">param_value</code> by <code class="function">clGetProgramBuildInfo</code> is
                        described in the table below.
                    </p>
              <div class="informaltable">
                <table class="informaltable" border="1">
                  <colgroup>
                    <col align="left" class="col1" />
                    <col align="left" class="col2" />
                  </colgroup>
                  <thead>
                    <tr>
                      <th align="left">cl_program_build_info</th>
                      <th align="left">Return Type and Info. returned in <code class="varname">param_value</code></th>
                    </tr>
                  </thead>
                  <tbody>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_PROGRAM_BUILD_STATUS</code>
                      </td>
                      <td align="left">Return type: cl_build_status
                                        <p>
                                            Returns the build status of <code class="varname">program</code> for a specific device
                                            as given by <code class="varname">device</code>. This can be one of the following:
                                        </p>
                                        <p>
                                            <span class="errorname">CL_BUILD_NONE</span>. The build status returned if no build has
                                            been performed on the specified program object for <code class="varname">device</code>.
                                        </p>
                                        <p>
                                            <span class="errorname">CL_BUILD_ERROR</span>. The build status returned if the last call
                                            to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the specified program object for <code class="varname">device</code>
                                            generated an error.
                                        </p>
                                        <p>
                                            <span class="errorname">CL_BUILD_SUCCESS</span>. The build status returned if the last call
                                            to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the
                                            specified program object for <code class="varname">device</code> was successful.
                                        </p>
                                        <p>
                                            <span class="errorname">CL_BUILD_IN_PROGRESS</span>. The build status returned if the last call
                                            to  <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the
                                            specified program object for <code class="varname">device</code> has not finished.
                                        </p>
                                    </td>
                    </tr>
                    <tr>
                      <td align="left">
                        <span class="errorname">CL_PROGRAM_BUILD_OPTIONS</span>
                      </td>
                      <td align="left">Return type: char[]
                                        <p>
                                            Return the build options specified by the <code class="varname">options</code> argument
                                            in  <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a>
                                            for <code class="varname">device</code>.
                                        </p>
                                        <p>
                                            If build status of <code class="varname">program</code> for <code class="varname">device</code>
                                            is <span class="errorname">CL_BUILD_NONE</span>, an empty string is returned.
                                        </p>
                                    </td>
                    </tr>
                    <tr>
                      <td align="left">
                        <span class="errorname">CL_PROGRAM_BUILD_LOG</span>
                      </td>
                      <td align="left">Return type: char[]
                                        <p>
                                        Return the build log when
                                        <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> was called
                                        for <code class="varname">device</code>. If build status of <code class="varname">program</code>
                                        for <code class="varname">device</code> is <span class="errorname">CL_BUILD_NONE</span>, an empty string
                                        is returned.</p>
                                    </td>
                    </tr>
                  </tbody>
                </table>
              </div>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">param_value</code>
              </span>
            </dt>
            <dd>
              <p>
                    A pointer to memory where the appropriate result being queried is returned.
                    If <code class="varname">param_value</code> is NULL, it is ignored.
                </p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">param_value_size</code>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the size in bytes of memory pointed to by <code class="varname">param_value</code>. This size
                    must be greater than or equal to the size of return type as described in the table above.
                </p>
            </dd>
            <dt>
              <span class="term">
                <code class="varname">param_value_size_ret</code>
              </span>
            </dt>
            <dd>
              <p>
                    Returns the actual size in bytes of data copied to <code class="varname">param_value</code>.
                    If <code class="varname">param_value_size_ret</code> is NULL, it is ignored.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1">
        <a id="errors"></a>
        <h2>Errors</h2>
        <p>
            Returns <span class="errorname">CL_SUCCESS</span> if the function is executed successfully.
            Otherwise it returns the following:
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc">
            Returns <span class="errorname">CL_INVALID_DEVICE</span> if <code class="varname">device</code>
            is not in the list of devices associated with <code class="varname">program</code>.
        </li>
            <li class="listitem" style="list-style-type: disc">
            Returns <span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code>
            is not valid, or if size in bytes specified by <code class="varname">param_value_size</code>
            is less than size of return type
            and <code class="varname">param_value</code> is not NULL.
        </li>
            <li class="listitem" style="list-style-type: disc">
            Returns <span class="errorname">CL_INVALID_PROGRAM</span> if <code class="varname">program</code>
            is a not a valid program object.
        </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
            resources required by the
            OpenCL implementation on the device.
        </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
            resources required by
            the OpenCL implementation on the host.
        </li>
          </ul>
        </div>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />


            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf#page=120" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="clGetProgramInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetProgramInfo</span></span></a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2010 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
    </div>
  </body>
</html>
